/*
 * Copyright (c) 2012, the Dart project authors.
 * 
 * Licensed under the Eclipse Public License v1.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 * 
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package com.google.dart.tools.search.ui;

/**
 * Listener interface for changes to an <code>ISearchResult</code>. Implementers of
 * <code>ISearchResult</code> should define subclasses of <code>SearchResultEvent</code> and send
 * those to registered listeners. Implementers of <code>ISearchResultListener</code> will in general
 * know the concrete class of search result they are listening to, and therefore the kind of events
 * they have to handle.
 * <p>
 * Clients may implement this interface.
 * </p>
 */
public interface ISearchResultListener {
  /**
   * Called to notify listeners of changes in a <code>ISearchResult</code>. The event object
   * <code>e</code> is only guaranteed to be valid for the duration of the call.
   * 
   * @param e the event object describing the change. Note that implementers of
   *          <code>ISearchResult</code> will be sending subclasses of
   *          <code>SearchResultEvent</code>
   */
  void searchResultChanged(SearchResultEvent e);
}
